<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>XMLPropertiesConfiguration xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/configuration/XMLPropertiesConfiguration.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *     <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.configuration;
<a class="jxr_linenumber" name="19" href="#19">19</a>  
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.io.PrintWriter;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.Reader;
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.io.Writer;
<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="27" href="#27">27</a>  
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParser;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParserFactory;
<a class="jxr_linenumber" name="30" href="#30">30</a>  
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringEscapeUtils;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.Attributes;
<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.EntityResolver;
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource;
<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.XMLReader;
<a class="jxr_linenumber" name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.helpers.DefaultHandler;
<a class="jxr_linenumber" name="38" href="#38">38</a>  
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * This configuration implements the XML properties format introduced in Java</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * 5.0, see <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html." target="alexandria_uri">http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html.</a></em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * An XML properties file looks like this:</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * &amp;lt;?xml version="1.0"?&gt;</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &amp;lt;!DOCTYPE properties SYSTEM "<a href="http://java.sun.com/dtd/properties.dtd" target="alexandria_uri">http://java.sun.com/dtd/properties.dtd</a>"&gt;</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &amp;lt;properties&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> *   &amp;lt;comment&gt;Description of the property list&amp;lt;/comment&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> *   &amp;lt;entry key="key1"&gt;value1&amp;lt;/entry&gt;</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> *   &amp;lt;entry key="key2"&gt;value2&amp;lt;/entry&gt;</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> *   &amp;lt;entry key="key3"&gt;value3&amp;lt;/entry&gt;</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &amp;lt;/properties&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * The Java 5.0 runtime is not required to use this class. The default encoding</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * for this configuration format is UTF-8. Note that unlike</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * {@code PropertiesConfiguration}, {@code XMLPropertiesConfiguration}</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * does not support includes.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * &lt;em&gt;Note:&lt;/em&gt;Configuration objects of this type can be read concurrently</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * by multiple threads. However if one of these threads modifies the object,</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * synchronization has to be performed manually.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> * @author Emmanuel Bourg</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> * @author Alistair Young</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> * @version $Id: XMLPropertiesConfiguration.java 1210207 2011-12-04 20:43:50Z oheger $</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/PropertiesConfiguration.html">PropertiesConfiguration</a>
<a class="jxr_linenumber" name="70" href="#70">70</a>  {
<a class="jxr_linenumber" name="71" href="#71">71</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * The default encoding (UTF-8 as specified by <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html)" target="alexandria_uri">http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html)</a></em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ENCODING = <span class="jxr_string">"UTF-8"</span>;
<a class="jxr_linenumber" name="75" href="#75">75</a>  
<a class="jxr_linenumber" name="76" href="#76">76</a>      <em class="jxr_comment">// initialization block to set the encoding before loading the file in the constructors</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>      {
<a class="jxr_linenumber" name="78" href="#78">78</a>          setEncoding(DEFAULT_ENCODING);
<a class="jxr_linenumber" name="79" href="#79">79</a>      }
<a class="jxr_linenumber" name="80" href="#80">80</a>  
<a class="jxr_linenumber" name="81" href="#81">81</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * Creates an empty XMLPropertyConfiguration object which can be</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * used to synthesize a new Properties file by adding values and</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * then saving(). An object constructed by this C'tor can not be</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * tickled into loading included files because it cannot supply a</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * base for relative includes.</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a>()
<a class="jxr_linenumber" name="89" href="#89">89</a>      {
<a class="jxr_linenumber" name="90" href="#90">90</a>          <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="91" href="#91">91</a>      }
<a class="jxr_linenumber" name="92" href="#92">92</a>  
<a class="jxr_linenumber" name="93" href="#93">93</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * Creates and loads the xml properties from the specified file.</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * The specified file can contain "include" properties which then</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * are loaded and merged into the properties.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @param fileName The name of the properties file to load.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * @throws ConfigurationException Error while loading the properties file</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="101" href="#101">101</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a>(String fileName) <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="102" href="#102">102</a>     {
<a class="jxr_linenumber" name="103" href="#103">103</a>         <strong class="jxr_keyword">super</strong>(fileName);
<a class="jxr_linenumber" name="104" href="#104">104</a>     }
<a class="jxr_linenumber" name="105" href="#105">105</a> 
<a class="jxr_linenumber" name="106" href="#106">106</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * Creates and loads the xml properties from the specified file.</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * The specified file can contain "include" properties which then</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * are loaded and merged into the properties.</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * @param file The properties file to load.</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @throws ConfigurationException Error while loading the properties file</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="114" href="#114">114</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a>(File file) <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="115" href="#115">115</a>     {
<a class="jxr_linenumber" name="116" href="#116">116</a>         <strong class="jxr_keyword">super</strong>(file);
<a class="jxr_linenumber" name="117" href="#117">117</a>     }
<a class="jxr_linenumber" name="118" href="#118">118</a> 
<a class="jxr_linenumber" name="119" href="#119">119</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * Creates and loads the xml properties from the specified URL.</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * The specified file can contain "include" properties which then</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * are loaded and merged into the properties.</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @param url The location of the properties file to load.</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * @throws ConfigurationException Error while loading the properties file</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="127" href="#127">127</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a>(URL url) <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="128" href="#128">128</a>     {
<a class="jxr_linenumber" name="129" href="#129">129</a>         <strong class="jxr_keyword">super</strong>(url);
<a class="jxr_linenumber" name="130" href="#130">130</a>     }
<a class="jxr_linenumber" name="131" href="#131">131</a> 
<a class="jxr_linenumber" name="132" href="#132">132</a>     @Override
<a class="jxr_linenumber" name="133" href="#133">133</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> load(Reader in) <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="134" href="#134">134</a>     {
<a class="jxr_linenumber" name="135" href="#135">135</a>         SAXParserFactory factory = SAXParserFactory.newInstance();
<a class="jxr_linenumber" name="136" href="#136">136</a>         factory.setNamespaceAware(false);
<a class="jxr_linenumber" name="137" href="#137">137</a>         factory.setValidating(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="138" href="#138">138</a> 
<a class="jxr_linenumber" name="139" href="#139">139</a>         <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="140" href="#140">140</a>         {
<a class="jxr_linenumber" name="141" href="#141">141</a>             SAXParser parser = factory.newSAXParser();
<a class="jxr_linenumber" name="142" href="#142">142</a> 
<a class="jxr_linenumber" name="143" href="#143">143</a>             XMLReader xmlReader = parser.getXMLReader();
<a class="jxr_linenumber" name="144" href="#144">144</a>             xmlReader.setEntityResolver(<strong class="jxr_keyword">new</strong> EntityResolver()
<a class="jxr_linenumber" name="145" href="#145">145</a>             {
<a class="jxr_linenumber" name="146" href="#146">146</a>                 <strong class="jxr_keyword">public</strong> InputSource resolveEntity(String publicId, String systemId)
<a class="jxr_linenumber" name="147" href="#147">147</a>                 {
<a class="jxr_linenumber" name="148" href="#148">148</a>                     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> InputSource(getClass().getClassLoader().getResourceAsStream(<span class="jxr_string">"properties.dtd"</span>));
<a class="jxr_linenumber" name="149" href="#149">149</a>                 }
<a class="jxr_linenumber" name="150" href="#150">150</a>             });
<a class="jxr_linenumber" name="151" href="#151">151</a>             xmlReader.setContentHandler(<strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesHandler</a>());
<a class="jxr_linenumber" name="152" href="#152">152</a>             xmlReader.parse(<strong class="jxr_keyword">new</strong> InputSource(in));
<a class="jxr_linenumber" name="153" href="#153">153</a>         }
<a class="jxr_linenumber" name="154" href="#154">154</a>         <strong class="jxr_keyword">catch</strong> (Exception e)
<a class="jxr_linenumber" name="155" href="#155">155</a>         {
<a class="jxr_linenumber" name="156" href="#156">156</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"Unable to parse the configuration file"</span>, e);
<a class="jxr_linenumber" name="157" href="#157">157</a>         }
<a class="jxr_linenumber" name="158" href="#158">158</a> 
<a class="jxr_linenumber" name="159" href="#159">159</a>         <em class="jxr_comment">// todo: support included properties ?</em>
<a class="jxr_linenumber" name="160" href="#160">160</a>     }
<a class="jxr_linenumber" name="161" href="#161">161</a> 
<a class="jxr_linenumber" name="162" href="#162">162</a>     @Override
<a class="jxr_linenumber" name="163" href="#163">163</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> save(Writer out) <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="164" href="#164">164</a>     {
<a class="jxr_linenumber" name="165" href="#165">165</a>         PrintWriter writer = <strong class="jxr_keyword">new</strong> PrintWriter(out);
<a class="jxr_linenumber" name="166" href="#166">166</a> 
<a class="jxr_linenumber" name="167" href="#167">167</a>         String encoding = getEncoding() != <strong class="jxr_keyword">null</strong> ? getEncoding() : DEFAULT_ENCODING;
<a class="jxr_linenumber" name="168" href="#168">168</a>         writer.println(<span class="jxr_string">"&lt;?xml version=\&quot;1.0\&quot; encoding=\&quot;"</span> + encoding + <span class="jxr_string">"\&quot;?&gt;"</span>);
<a class="jxr_linenumber" name="169" href="#169">169</a>         writer.println(<span class="jxr_string">"&lt;!DOCTYPE properties SYSTEM \&quot;http://java.sun.com/dtd/properties.dtd\&quot;&gt;"</span>);
<a class="jxr_linenumber" name="170" href="#170">170</a>         writer.println(<span class="jxr_string">"&lt;properties&gt;"</span>);
<a class="jxr_linenumber" name="171" href="#171">171</a> 
<a class="jxr_linenumber" name="172" href="#172">172</a>         <strong class="jxr_keyword">if</strong> (getHeader() != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="173" href="#173">173</a>         {
<a class="jxr_linenumber" name="174" href="#174">174</a>             writer.println(<span class="jxr_string">"  &lt;comment&gt;"</span> + StringEscapeUtils.escapeXml(getHeader()) + <span class="jxr_string">"&lt;/comment&gt;"</span>);
<a class="jxr_linenumber" name="175" href="#175">175</a>         }
<a class="jxr_linenumber" name="176" href="#176">176</a> 
<a class="jxr_linenumber" name="177" href="#177">177</a>         Iterator&lt;String&gt; keys = getKeys();
<a class="jxr_linenumber" name="178" href="#178">178</a>         <strong class="jxr_keyword">while</strong> (keys.hasNext())
<a class="jxr_linenumber" name="179" href="#179">179</a>         {
<a class="jxr_linenumber" name="180" href="#180">180</a>             String key = keys.next();
<a class="jxr_linenumber" name="181" href="#181">181</a>             Object value = getProperty(key);
<a class="jxr_linenumber" name="182" href="#182">182</a> 
<a class="jxr_linenumber" name="183" href="#183">183</a>             <strong class="jxr_keyword">if</strong> (value instanceof List)
<a class="jxr_linenumber" name="184" href="#184">184</a>             {
<a class="jxr_linenumber" name="185" href="#185">185</a>                 writeProperty(writer, key, (List&lt;?&gt;) value);
<a class="jxr_linenumber" name="186" href="#186">186</a>             }
<a class="jxr_linenumber" name="187" href="#187">187</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="188" href="#188">188</a>             {
<a class="jxr_linenumber" name="189" href="#189">189</a>                 writeProperty(writer, key, value);
<a class="jxr_linenumber" name="190" href="#190">190</a>             }
<a class="jxr_linenumber" name="191" href="#191">191</a>         }
<a class="jxr_linenumber" name="192" href="#192">192</a> 
<a class="jxr_linenumber" name="193" href="#193">193</a>         writer.println(<span class="jxr_string">"&lt;/properties&gt;"</span>);
<a class="jxr_linenumber" name="194" href="#194">194</a>         writer.flush();
<a class="jxr_linenumber" name="195" href="#195">195</a>     }
<a class="jxr_linenumber" name="196" href="#196">196</a> 
<a class="jxr_linenumber" name="197" href="#197">197</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * Write a property.</em>
<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * @param out the output stream</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * @param key the key of the property</em>
<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * @param value the value of the property</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="204" href="#204">204</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(PrintWriter out, String key, Object value)
<a class="jxr_linenumber" name="205" href="#205">205</a>     {
<a class="jxr_linenumber" name="206" href="#206">206</a>         <em class="jxr_comment">// escape the key</em>
<a class="jxr_linenumber" name="207" href="#207">207</a>         String k = StringEscapeUtils.escapeXml(key);
<a class="jxr_linenumber" name="208" href="#208">208</a> 
<a class="jxr_linenumber" name="209" href="#209">209</a>         <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="210" href="#210">210</a>         {
<a class="jxr_linenumber" name="211" href="#211">211</a>             <em class="jxr_comment">// escape the value</em>
<a class="jxr_linenumber" name="212" href="#212">212</a>             String v = StringEscapeUtils.escapeXml(String.valueOf(value));
<a class="jxr_linenumber" name="213" href="#213">213</a>             v = StringUtils.replace(v, String.valueOf(getListDelimiter()), <span class="jxr_string">"&#92;&#92;"</span> + getListDelimiter());
<a class="jxr_linenumber" name="214" href="#214">214</a> 
<a class="jxr_linenumber" name="215" href="#215">215</a>             out.println(<span class="jxr_string">"  &lt;entry key=\&quot;"</span> + k + <span class="jxr_string">"\&quot;&gt;"</span> + v + <span class="jxr_string">"&lt;/entry&gt;"</span>);
<a class="jxr_linenumber" name="216" href="#216">216</a>         }
<a class="jxr_linenumber" name="217" href="#217">217</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="218" href="#218">218</a>         {
<a class="jxr_linenumber" name="219" href="#219">219</a>             out.println(<span class="jxr_string">"  &lt;entry key=\&quot;"</span> + k + <span class="jxr_string">"\&quot;/&gt;"</span>);
<a class="jxr_linenumber" name="220" href="#220">220</a>         }
<a class="jxr_linenumber" name="221" href="#221">221</a>     }
<a class="jxr_linenumber" name="222" href="#222">222</a> 
<a class="jxr_linenumber" name="223" href="#223">223</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Write a list property.</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * @param out the output stream</em>
<a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * @param key the key of the property</em>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * @param values a list with all property values</em>
<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="230" href="#230">230</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(PrintWriter out, String key, List&lt;?&gt; values)
<a class="jxr_linenumber" name="231" href="#231">231</a>     {
<a class="jxr_linenumber" name="232" href="#232">232</a>         <strong class="jxr_keyword">for</strong> (Object value : values)
<a class="jxr_linenumber" name="233" href="#233">233</a>         {
<a class="jxr_linenumber" name="234" href="#234">234</a>             writeProperty(out, key, value);
<a class="jxr_linenumber" name="235" href="#235">235</a>         }
<a class="jxr_linenumber" name="236" href="#236">236</a>     }
<a class="jxr_linenumber" name="237" href="#237">237</a> 
<a class="jxr_linenumber" name="238" href="#238">238</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * SAX Handler to parse a XML properties file.</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * @author Alistair Young</em>
<a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * @since 1.2</em>
<a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="244" href="#244">244</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesHandler</a> <strong class="jxr_keyword">extends</strong> DefaultHandler
<a class="jxr_linenumber" name="245" href="#245">245</a>     {
<a class="jxr_linenumber" name="246" href="#246">246</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The key of the current entry being parsed. */</em>
<a class="jxr_linenumber" name="247" href="#247">247</a>         <strong class="jxr_keyword">private</strong> String key;
<a class="jxr_linenumber" name="248" href="#248">248</a> 
<a class="jxr_linenumber" name="249" href="#249">249</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The value of the current entry being parsed. */</em>
<a class="jxr_linenumber" name="250" href="#250">250</a>         <strong class="jxr_keyword">private</strong> StringBuilder value = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="251" href="#251">251</a> 
<a class="jxr_linenumber" name="252" href="#252">252</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Indicates that a comment is being parsed. */</em>
<a class="jxr_linenumber" name="253" href="#253">253</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inCommentElement;
<a class="jxr_linenumber" name="254" href="#254">254</a> 
<a class="jxr_linenumber" name="255" href="#255">255</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Indicates that an entry is being parsed. */</em>
<a class="jxr_linenumber" name="256" href="#256">256</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inEntryElement;
<a class="jxr_linenumber" name="257" href="#257">257</a> 
<a class="jxr_linenumber" name="258" href="#258">258</a>         @Override
<a class="jxr_linenumber" name="259" href="#259">259</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> startElement(String uri, String localName, String qName, Attributes attrs)
<a class="jxr_linenumber" name="260" href="#260">260</a>         {
<a class="jxr_linenumber" name="261" href="#261">261</a>             <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"comment"</span>.equals(qName))
<a class="jxr_linenumber" name="262" href="#262">262</a>             {
<a class="jxr_linenumber" name="263" href="#263">263</a>                 inCommentElement = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="264" href="#264">264</a>             }
<a class="jxr_linenumber" name="265" href="#265">265</a> 
<a class="jxr_linenumber" name="266" href="#266">266</a>             <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"entry"</span>.equals(qName))
<a class="jxr_linenumber" name="267" href="#267">267</a>             {
<a class="jxr_linenumber" name="268" href="#268">268</a>                 key = attrs.getValue(<span class="jxr_string">"key"</span>);
<a class="jxr_linenumber" name="269" href="#269">269</a>                 inEntryElement = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="270" href="#270">270</a>             }
<a class="jxr_linenumber" name="271" href="#271">271</a>         }
<a class="jxr_linenumber" name="272" href="#272">272</a> 
<a class="jxr_linenumber" name="273" href="#273">273</a>         @Override
<a class="jxr_linenumber" name="274" href="#274">274</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endElement(String uri, String localName, String qName)
<a class="jxr_linenumber" name="275" href="#275">275</a>         {
<a class="jxr_linenumber" name="276" href="#276">276</a>             <strong class="jxr_keyword">if</strong> (inCommentElement)
<a class="jxr_linenumber" name="277" href="#277">277</a>             {
<a class="jxr_linenumber" name="278" href="#278">278</a>                 <em class="jxr_comment">// We've just finished a &lt;comment&gt; element so set the header</em>
<a class="jxr_linenumber" name="279" href="#279">279</a>                 setHeader(value.toString());
<a class="jxr_linenumber" name="280" href="#280">280</a>                 inCommentElement = false;
<a class="jxr_linenumber" name="281" href="#281">281</a>             }
<a class="jxr_linenumber" name="282" href="#282">282</a> 
<a class="jxr_linenumber" name="283" href="#283">283</a>             <strong class="jxr_keyword">if</strong> (inEntryElement)
<a class="jxr_linenumber" name="284" href="#284">284</a>             {
<a class="jxr_linenumber" name="285" href="#285">285</a>                 <em class="jxr_comment">// We've just finished an &lt;entry&gt; element, so add the key/value pair</em>
<a class="jxr_linenumber" name="286" href="#286">286</a>                 addProperty(key, value.toString());
<a class="jxr_linenumber" name="287" href="#287">287</a>                 inEntryElement = false;
<a class="jxr_linenumber" name="288" href="#288">288</a>             }
<a class="jxr_linenumber" name="289" href="#289">289</a> 
<a class="jxr_linenumber" name="290" href="#290">290</a>             <em class="jxr_comment">// Clear the element value buffer</em>
<a class="jxr_linenumber" name="291" href="#291">291</a>             value = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="292" href="#292">292</a>         }
<a class="jxr_linenumber" name="293" href="#293">293</a> 
<a class="jxr_linenumber" name="294" href="#294">294</a>         @Override
<a class="jxr_linenumber" name="295" href="#295">295</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> characters(<strong class="jxr_keyword">char</strong>[] chars, <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">int</strong> length)
<a class="jxr_linenumber" name="296" href="#296">296</a>         {
<a class="jxr_linenumber" name="297" href="#297">297</a>             <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment">             * We're currently processing an element. All character data from now until</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment">             * the next endElement() call will be the data for this  element.</em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment">             */</em>
<a class="jxr_linenumber" name="301" href="#301">301</a>             value.append(chars, start, length);
<a class="jxr_linenumber" name="302" href="#302">302</a>         }
<a class="jxr_linenumber" name="303" href="#303">303</a>     }
<a class="jxr_linenumber" name="304" href="#304">304</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

